Python docs + a small C++ selection, done by hand#20
Open
simonevadi wants to merge 10 commits into
Open
Conversation
- examples/tutorial_tracing.py: runnable example using tests/res/test.rml, verified against installed rayx 0.4.3 - event_type column is uint32; comparisons need EventType.X.value not the enum object directly - Rays on the image plane appear as HIT_ELEMENT, not ABSORBED - Remove fix_seed/DeviceType references (not in current PyPI release) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GXnPW72q5DnUoApAU7mvLL
valentinstoecker
requested changes
Jul 1, 2026
Collaborator
There was a problem hiding this comment.
I would prefer a script written in python instead of bash. The dev dependencies should be available if it is executed like this uv run tools/build_docs.py
Collaborator
|
when you're done with the requested changes please run |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This MR sets up the initial documentation infrastructure using Read the Docs.
It includes:
At the moment, the API documentation is maintained by hand. The next step will be to automate the generation of the Python API documentation (e.g., via autodoc or a similar approach).
Additionally, this MR adds a helper script to build and preview the documentation locally:
The script creates a dedicated virtual environment for the documentation, installs the required dependencies, builds the HTML documentation, and serves the output from
docs/_build/html/.